DirectCall

interface DirectCall

DirectCall

Since

0.6.0

Functions

accept

abstract fun accept(params: AcceptParams?)

Accepts call.

captureLocalVideoView

abstract fun captureLocalVideoView(handler: CaptureVideoViewHandler?)

Captures local video view.

captureRemoteVideoView

abstract fun captureRemoteVideoView(handler: CaptureVideoViewHandler?)

Captures remote video view.

deleteAllCustomItems

abstract fun deleteAllCustomItems(handler: CustomItemsHandler?)

Deletes all custom items.

deleteCustomItems

abstract fun deleteCustomItems(customItemKeys: Set<String>?, handler: CustomItemsHandler?)

Deletes custom items.

end

abstract fun end()

Ends call.

fetchBluetoothDevices

abstract fun fetchBluetoothDevices()

hold

abstract fun hold(handler: CompletionHandler?)

Holds the active call.

muteMicrophone

abstract fun muteMicrophone(): Boolean

Mutes microphone.

removeConnectionQualityListener

abstract fun removeConnectionQualityListener()

Removes the listener for connection quality and its monitoring modes.

resumeVideoCapturer

abstract fun resumeVideoCapturer()

Connects the device camera and Sendbird Calls SDK to stream video.

selectAudioDevice

abstract fun selectAudioDevice(audioDevice: AudioDevice, handler: CompletionHandler?)

Selects audio device.

selectVideoDevice

abstract fun selectVideoDevice(videoDevice: VideoDevice, handler: CompletionHandler?)

Selects VideoDevice.

setConnectionQualityListener

abstract fun setConnectionQualityListener(mode: ConnectionQualityMonitoringMode, listener: ConnectionQualityListener)

Sets the listener for connection quality and its monitoring modes.

setListener

abstract fun setListener(listener: DirectCallListener?)

Sets DirectCall listener.

setLocalVideoView

abstract fun setLocalVideoView(videoView: SendBirdVideoView?)

Sets local video view.

setRemoteVideoView

abstract fun setRemoteVideoView(videoView: SendBirdVideoView?)

Sets remote video view.

startRecording

abstract fun startRecording(options: RecordingOptions, handler: RecordingStartedHandler?)

Starts a media recording session of a direct call. Only one ongoing recording session is allowed. It requires API level 18 or higher.

startScreenShare

abstract fun startScreenShare(mediaProjectionPermissionResultData: Intent, handler: CompletionHandler?)

Starts the screen share of the local user.

startVideo

abstract fun startVideo()

Starts video.

stopRecording

abstract fun stopRecording(recordingId: String): Boolean

Stops a media recording session with the specified recordingId, and depending on the result of the recording, calls the methods of com.sendbird.calls.handler.RecordingListener. It requires API level 18 or higher.

stopScreenShare

abstract fun stopScreenShare(handler: CompletionHandler?)

Stops the screen share of the local user.

stopVideo

abstract fun stopVideo()

Stops video.

switchCamera

abstract fun switchCamera(handler: CompletionHandler?)

Toggles the selection between the front and the back camera. In case of more than two cameras, the next camera will be selected. If the last camera is already selected, the first one will be selected again.

unhold

abstract fun unhold(force: Boolean, handler: CompletionHandler?)

Removes the hold that you put on a call.

unmuteMicrophone

abstract fun unmuteMicrophone(): Boolean

Unmutes microphone.

updateCustomItems

abstract fun updateCustomItems(customItems: Map<String, String>, handler: CustomItemsHandler?)

Updates custom items.

Properties

availableAudioDevices

abstract val availableAudioDevices: Set<AudioDevice>

Gets available audio devices.

availableVideoDevices

abstract val availableVideoDevices: List<VideoDevice>

Gets available video devices.

callee

abstract val callee: DirectCallUser?

Gets callee.

caller

abstract val caller: DirectCallUser?

Gets caller.

callId

abstract val callId: String?

Gets call ID.

callLog

abstract val callLog: DirectCallLog?

Gets call log.

currentAudioDevice

abstract val currentAudioDevice: AudioDevice?

Gets current audio device.

currentVideoDevice

abstract val currentVideoDevice: VideoDevice?

Gets current video device.

customItems

abstract val customItems: Map<String, String>

Gets custom items of this DirectCall instance.

duration

abstract val duration: Long

Gets call duration(ms).

endedBy

abstract val endedBy: DirectCallUser?

Gets ender.

endResult

abstract val endResult: DirectCallEndResult

Gets end result.

isEnded

abstract val isEnded: Boolean

Is ended.

isLocalAudioEnabled

abstract val isLocalAudioEnabled: Boolean

Is local audio enabled.

isLocalScreenShareEnabled

abstract val isLocalScreenShareEnabled: Boolean

Indicates whether the local user's screen is being shared.

isLocalVideoEnabled

abstract val isLocalVideoEnabled: Boolean

Is local video enabled.

isOngoing

abstract val isOngoing: Boolean

Is ongoing.

isOnHold

abstract val isOnHold: Boolean

Indicates whether the call is on hold by either a callee or a caller, or by both.

isRemoteAudioEnabled

abstract val isRemoteAudioEnabled: Boolean

Is remote audio enabled.

isRemoteVideoEnabled

abstract val isRemoteVideoEnabled: Boolean

Is remote video enabled.

isVideoCall

abstract val isVideoCall: Boolean

Is video call.

localRecordingStatus

abstract val localRecordingStatus: RecordingStatus

Gets local recording status.

localUser

abstract val localUser: DirectCallUser?

Gets local user.

myRole

abstract val myRole: DirectCallUserRole?

Gets my role.

remoteRecordingStatus

abstract val remoteRecordingStatus: RecordingStatus

Gets remote recording status.

remoteUser

abstract val remoteUser: DirectCallUser?

Gets remote user.

ringingSource

abstract val ringingSource: RingingSource?

Enum value indicating where the DirectCall's dial event came from.

startedAt

abstract val startedAt: Long

Gets call started at(ms).